/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.gui.model;

/**
 * Root class for the messages used in the message system of the model.
 * 
 * @author		Schnell Michaël
 * @version		1.0
 */
public class Message {
	
	/**
	 * Unique identifier for each message.
	 */
	protected int index ;
	
	/**
	 * Builds an instance with a default index.
	 */
	public Message() {
		this(0) ;
	}// Message()
	
	/**
	 * Builds an instance with the given index.
	 * 
	 * @param 	index
	 * 			index for this instance
	 */
	public Message(int index) {
		super() ;
		this.index = index ;
	}// Message(int)

	/**
	 * Returns the index of this instance.
	 * 
	 * @return	Index of this instance
	 */
	public int getIndex() {
		return this.index ;
	}// getIndex()
	
	/**
	 * Sets the index  of this instance.
	 * 
	 * @param	index
	 * 			new index of this instance
	 */
	public void setIndex(int index) {
		this.index = index ;
	}// setIndex(int)
	
	/**
	 * Indicates whether another object is "equal" to this one.
	 * Two instances of {@code Message} are "equal" if their
	 * indexes are the same.
	 * 
	 * @param	obj
	 * 			object compared to this one
	 */
	@Override
	public boolean equals(Object obj) {
		if ((obj == null) || !(obj instanceof Message)) {
			return false ;
		}// if
		Message other = (Message) obj ;
		return (this.index == other.index) ;
	}// equals(Object)
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public int hashCode() {
		return new Integer(this.index).hashCode() ;
	}// hashCode()

}// class Message